home *** CD-ROM | disk | FTP | other *** search
/ Video Toaster 4.2 / Video Toaster v4.2.iso / programs / documentation / lightwave / screamernetii.txt < prev   
Text File  |  1995-07-20  |  4KB  |  88 lines
  1. LightWave ScreamerNet II Commands
  2. =================================
  3.     Allen Hastings
  4.     last revised 7/95
  5.  
  6.  
  7. This document briefly summarizes the commands recognized by ScreamerNet
  8. render modules running in SN II mode (started with the "-2" option), and is
  9. current as of version 3.99d.
  10.  
  11. To send a command to a render module, write it into the first line of the
  12. job file specified when the render module was executed (the filename is the
  13. second argument of the LWSN command line).  Note that render modules tries
  14. to read a config file before starting to poll the job file, which means that
  15. the filenames appearing with the "load" and "output" commands may be
  16. relative to a content directory set by the config file.  Another thing to
  17. note is that if the same command is sent multiple times in a row, the render
  18. module will ignore all but the first instance (with the exception of the
  19. "wait" and "init" commands).  If multiple render commands are sent in a row,
  20. they are not ignored if the specified frame range is different from one
  21. command to the next.
  22.  
  23.  
  24. wait <additional delay time>
  25.  
  26.   This command tells the render module to wait.  It will write "Ready" into
  27.   its acknowledgement file after receiving the command (before pausing).
  28.   The pause will normally be one second, after which the render module will
  29.   again read its job file, but an optional integer can be added after the
  30.   wait command specifying an additional number of seconds of delay.
  31.  
  32.   This command will often be sent to a render module right after another
  33.   command that may take a while to complete (like "render").  This allows
  34.   a render farm controller to determine when the previous task has been
  35.   completed by waiting for "Ready" in the acknowledgement file.  In an
  36.   earlier version of SN II, "Ready" was returned when any command finished,
  37.   but this caused problems when commands were completed quickly.  For
  38.   example, a fast machine might finish rendering a frame before the
  39.   controller ever saw the acknowledgement that rendering had begun.  The
  40.   current scheme avoids such potential confusion.
  41.  
  42.  
  43. init
  44.  
  45.   This command causes the render module to clear its current scene and
  46.   return the type of CPU it's running on.  The acknowledgement file will
  47.   contain the word "Initializing" on line one and the machine name (which
  48.   currently is one of "Amiga", "x86", "MIPS", "Alpha", or "SGI") on line
  49.   two.
  50.  
  51.  
  52. load <scene filename>
  53.  
  54.   This command causes the render module to load the specified scene file.
  55.   The filename is often on another networked machine, and, as mentioned
  56.   earlier, it may be relative to a content directory if the render module
  57.   found a config file when it first started.  This also applies to the
  58.   object and image filenames specified within the scene file.  "Loading"
  59.   will be written into the acknowledgement file.
  60.  
  61.  
  62. render <first frame> <last frame> <frame step>
  63.  
  64.   This command causes the render module to render the specified frames of
  65.   the scene that was loaded with the "load" command.  LightWave 4.0's
  66.   built-in controller always sets the last frame equal to the first frame
  67.   (so that only one frame is generated per render command), but this is
  68.   not necessary.  "
  69.  
  70.  
  71. output <RGB image prefix> <alpha image prefix>
  72.  
  73.   This command sets the prefix parts of the filenames using by the render
  74.   module to save rendered RGB and alpha channel output.  As in LightWave's
  75.   record panel and scene files, the prefix also includes the file path.
  76.   Either prefix may also read "(none)", which turns off saving of that type
  77.   of image.  Note that if a 32-bit RGB output format is in use, the alpha
  78.   channel will be saved in the same files as the color information and the
  79.   alpha prefix should then be set to "(none)".  LightWave's built-in
  80.   controller does not use this command, which means that the prefixes set
  81.   by the scene file itself are used.
  82.  
  83.  
  84. quit
  85.  
  86.   This commands ends execution of the render module.  Before the module
  87.   exits, it writes "Offline" into its acknowledgement file.
  88.